CuDoubleSidedScannerAPI  1.11
Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus Class Reference

Class that stores the scanner status. To create an instance of this object, use GetStatus(). More...

Public Types

enum  SensorStatus : byte
 Paper sensors status More...
 

Public Member Functions

String ConvertToString ()
 Creates a string containing the status values More...
 

Properties

SensorStatus SensorInputFarRight [get, set]
 
SensorStatus SensorInputCenterRight [get, set]
 
SensorStatus SensorInputCenterLeft [get, set]
 
SensorStatus SensorInputFarLeft [get, set]
 
SensorStatus SensorInternalLeft [get, set]
 
SensorStatus SensorInternalRight [get, set]
 
SensorStatus SensorOutputFarRight [get, set]
 
SensorStatus SensorOutputCenterRight [get, set]
 
SensorStatus SensorOutputCenterLeft [get, set]
 
SensorStatus SensorOutputFarLeft [get, set]
 
bool DoubleSheet [get, set]
 
Boolean ScanCanceled [get, set]
 
Boolean ScanInProgress [get, set]
 
Boolean LoadingPaper [get, set]
 
Boolean CoverOpen [get, set]
 
Boolean PaperJam [get, set]
 
Boolean JamPaperHeldBack [get, set]
 
Boolean MotorIsON [get, set]
 
Boolean TicketOnEnterCenter [get, set]
 
Boolean TicketOnEnterA4 [get, set]
 
Boolean TicketLoaded [get, set]
 
Boolean TicketOnExit [get, set]
 
SensorStatus SensorVoidPrintHead [get, set]
 
Boolean PrintHeadReady [get, set]
 
Boolean ExternalCoverOpen [get, set]
 

Detailed Description

Class that stores the scanner status. To create an instance of this object, use GetStatus().

Member Enumeration Documentation

◆ SensorStatus

Paper sensors status

Enumerator
NO_PAPER 

Indicates that no paper is present on the sensor

PAPER_PRESENT 

Indicates that a sheet is present upon the sensor

NOT_AVAILABLE 

Indicates that the sensor is not available on this device

Member Function Documentation

◆ ConvertToString()

String Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString ( )
inline

Creates a string containing the status values

Returns
A string with the text description of the current status

Property Documentation

◆ CoverOpen

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.CoverOpen
getset

Indicates that the scanner cover is open.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ DoubleSheet

bool Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.DoubleSheet
getset

Indicates whether one or more sheets have been loaded.

false indicates that everithing is OK, because 1 paper sheet has been loaded.

true indicates that more than 1 sheet has been loaded, and the scan job will stop (error condition).

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ ExternalCoverOpen

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ExternalCoverOpen
getset

Indicates that the external cover is open (Only for Scan A4-SE scanners)

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ JamPaperHeldBack

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.JamPaperHeldBack
getset

Indicates that the sheet to be scanned has been held back by the user.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ LoadingPaper

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.LoadingPaper
getset

Indicates that the scanner is loading paper.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ MotorIsON

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.MotorIsON
getset

Indicates that the scanner engine is On.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ PaperJam

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.PaperJam
getset

Indicates that the scanner is jammed.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ PrintHeadReady

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.PrintHeadReady
getset

TRUE if the void print head is ready to print. FALSE otherwise. For scanners that do not support the void print, please ignore this value.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ ScanCanceled

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ScanCanceled
getset

Indicates that the scan operation has been canceled.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ ScanInProgress

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ScanInProgress
getset

Indicates that the scan operation is in progress.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInputCenterLeft

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInputCenterLeft
getset

Input-center-left sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInputCenterRight

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInputCenterRight
getset

Input-center-right sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInputFarLeft

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInputFarLeft
getset

Input-far-left sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInputFarRight

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInputFarRight
getset

Input-far-right sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInternalLeft

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInternalLeft
getset

Internal-left sensor status. (left-deskewing sensor )

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorInternalRight

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorInternalRight
getset

Internal-right sensor status. (right-deskewing sensor )

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorOutputCenterLeft

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorOutputCenterLeft
getset

Output-center-left sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorOutputCenterRight

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorOutputCenterRight
getset

Output-center-right sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorOutputFarLeft

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorOutputFarLeft
getset

Output-far-left sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorOutputFarRight

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorOutputFarRight
getset

Output-far-right sensor status.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ SensorVoidPrintHead

SensorStatus Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.SensorVoidPrintHead
getset

Void print head sensor status. TRUE if the paper is upon the sensor.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ TicketLoaded

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.TicketLoaded
getset

Indicates that a ticket has been loaded by the scanner, and is present inside the scanner.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ TicketOnEnterA4

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.TicketOnEnterA4
getset

Indicates that a large ticket is present on the input scanner mouth, ready to be inserted into the scanner. Only for A4 scanners.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ TicketOnEnterCenter

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.TicketOnEnterCenter
getset

Indicates that a ticket is present on the input scanner mouth, ready to be inserted into the scanner. Ticket width doesn't matter: if TRUE, a ticket of any width is present on the central part of the scanner mouth.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().

◆ TicketOnExit

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.TicketOnExit
getset

Indicates that a ticket is present on the back side of the scanner.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScannerStatus.ConvertToString().